<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>EOS.IO: Table&lt; scope, code, table, Record, PrimaryType, void &gt;::PrimaryIndex Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="eos-logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">EOS.IO
   &#160;<span id="projectnumber">DAWN1.1.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="struct_table_3_01scope_00_01code_00_01table_00_01_record_00_01_primary_type_00_01void_01_4.html">Table&lt; scope, code, table, Record, PrimaryType, void &gt;</a></li><li class="navelem"><a class="el" href="struct_table_3_01scope_00_01code_00_01table_00_01_record_00_01_primary_type_00_01void_01_4_1_1_primary_index.html">PrimaryIndex</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="struct_table_3_01scope_00_01code_00_01table_00_01_record_00_01_primary_type_00_01void_01_4_1_1_primary_index-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Table&lt; scope, code, table, Record, PrimaryType, void &gt;::PrimaryIndex Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Primary Index of <a class="el" href="struct_table.html">Table</a>.  
</p>

<p><code>#include &lt;<a class="el" href="db_8hpp_source.html">db.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a2738339698d7567b429328ea96859332"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_table_3_01scope_00_01code_00_01table_00_01_record_00_01_primary_type_00_01void_01_4_1_1_primary_index.html#a2738339698d7567b429328ea96859332">front</a> (Record &amp;r)</td></tr>
<tr class="separator:a2738339698d7567b429328ea96859332"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ff50a9331a8df3c6b01bd6e6eac0ac4"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_table_3_01scope_00_01code_00_01table_00_01_record_00_01_primary_type_00_01void_01_4_1_1_primary_index.html#a5ff50a9331a8df3c6b01bd6e6eac0ac4">back</a> (Record &amp;r)</td></tr>
<tr class="separator:a5ff50a9331a8df3c6b01bd6e6eac0ac4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af536063f7c2a26077894e6cc045f71bc"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_table_3_01scope_00_01code_00_01table_00_01_record_00_01_primary_type_00_01void_01_4_1_1_primary_index.html#af536063f7c2a26077894e6cc045f71bc">next</a> (Record &amp;r)</td></tr>
<tr class="separator:af536063f7c2a26077894e6cc045f71bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae114281983f6b82ccd54e04a96baf5ed"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_table_3_01scope_00_01code_00_01table_00_01_record_00_01_primary_type_00_01void_01_4_1_1_primary_index.html#ae114281983f6b82ccd54e04a96baf5ed">previous</a> (Record &amp;r)</td></tr>
<tr class="separator:ae114281983f6b82ccd54e04a96baf5ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15f64dc829bde56071b4355f8e28ac29"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_table_3_01scope_00_01code_00_01table_00_01_record_00_01_primary_type_00_01void_01_4_1_1_primary_index.html#a15f64dc829bde56071b4355f8e28ac29">get</a> (const PrimaryType &amp;p, Record &amp;r, <a class="el" href="group__types.html#gaaa5d1cd013383c889537491c3cfd9aad">uint64_t</a> s=scope)</td></tr>
<tr class="separator:a15f64dc829bde56071b4355f8e28ac29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf2e9c1cac71e8893f3d77227816e4e6"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_table_3_01scope_00_01code_00_01table_00_01_record_00_01_primary_type_00_01void_01_4_1_1_primary_index.html#aaf2e9c1cac71e8893f3d77227816e4e6">lower_bound</a> (const PrimaryType &amp;p, Record &amp;r)</td></tr>
<tr class="separator:aaf2e9c1cac71e8893f3d77227816e4e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b86d0c5f0a735e6f962984c00925372"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_table_3_01scope_00_01code_00_01table_00_01_record_00_01_primary_type_00_01void_01_4_1_1_primary_index.html#a6b86d0c5f0a735e6f962984c00925372">upper_bound</a> (const PrimaryType &amp;p, Record &amp;r)</td></tr>
<tr class="separator:a6b86d0c5f0a735e6f962984c00925372"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88d1097b8bcd991a7bd8a0519719ea5c"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_table_3_01scope_00_01code_00_01table_00_01_record_00_01_primary_type_00_01void_01_4_1_1_primary_index.html#a88d1097b8bcd991a7bd8a0519719ea5c">remove</a> (const Record &amp;r)</td></tr>
<tr class="separator:a88d1097b8bcd991a7bd8a0519719ea5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a5ff50a9331a8df3c6b01bd6e6eac0ac4"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;uint64_t scope, uint64_t code, uint64_t table, typename Record , typename PrimaryType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="struct_table.html">Table</a>&lt; scope, code, table, Record, PrimaryType, void &gt;::PrimaryIndex::back </td>
          <td>(</td>
          <td class="paramtype">Record &amp;&#160;</td>
          <td class="paramname"><em>r</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">r</td><td>- reference to a record to store the back.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successfully retrieved the back of the table. </dd></dl>

</div>
</div>
<a class="anchor" id="a2738339698d7567b429328ea96859332"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;uint64_t scope, uint64_t code, uint64_t table, typename Record , typename PrimaryType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="struct_table.html">Table</a>&lt; scope, code, table, Record, PrimaryType, void &gt;::PrimaryIndex::front </td>
          <td>(</td>
          <td class="paramtype">Record &amp;&#160;</td>
          <td class="paramname"><em>r</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">r</td><td>- reference to a record to store the front.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successfully retrieved the front of the table. </dd></dl>

</div>
</div>
<a class="anchor" id="a15f64dc829bde56071b4355f8e28ac29"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;uint64_t scope, uint64_t code, uint64_t table, typename Record , typename PrimaryType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="struct_table.html">Table</a>&lt; scope, code, table, Record, PrimaryType, void &gt;::PrimaryIndex::get </td>
          <td>(</td>
          <td class="paramtype">const PrimaryType &amp;&#160;</td>
          <td class="paramname"><em>p</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Record &amp;&#160;</td>
          <td class="paramname"><em>r</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#gaaa5d1cd013383c889537491c3cfd9aad">uint64_t</a>&#160;</td>
          <td class="paramname"><em>s</em> = <code>scope</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">p</td><td>- reference to the primary key to retrieve the record. </td></tr>
    <tr><td class="paramname">r</td><td>- reference to hold the result of the query. </td></tr>
    <tr><td class="paramname">s</td><td>- scope; defaults to scope of the class. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successfully retrieved the record. </dd></dl>

</div>
</div>
<a class="anchor" id="aaf2e9c1cac71e8893f3d77227816e4e6"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;uint64_t scope, uint64_t code, uint64_t table, typename Record , typename PrimaryType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="struct_table.html">Table</a>&lt; scope, code, table, Record, PrimaryType, void &gt;::PrimaryIndex::lower_bound </td>
          <td>(</td>
          <td class="paramtype">const PrimaryType &amp;&#160;</td>
          <td class="paramname"><em>p</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Record &amp;&#160;</td>
          <td class="paramname"><em>r</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">p</td><td>- reference to the primary key to retrieve the lower bound. </td></tr>
    <tr><td class="paramname">r</td><td>- reference to hold the result of the query. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successfully retrieved the record. </dd></dl>

</div>
</div>
<a class="anchor" id="af536063f7c2a26077894e6cc045f71bc"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;uint64_t scope, uint64_t code, uint64_t table, typename Record , typename PrimaryType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="struct_table.html">Table</a>&lt; scope, code, table, Record, PrimaryType, void &gt;::PrimaryIndex::next </td>
          <td>(</td>
          <td class="paramtype">Record &amp;&#160;</td>
          <td class="paramname"><em>r</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">r</td><td>- reference to store the next record. Must be initialized with a key.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successfully retrieved the next record. </dd></dl>

</div>
</div>
<a class="anchor" id="ae114281983f6b82ccd54e04a96baf5ed"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;uint64_t scope, uint64_t code, uint64_t table, typename Record , typename PrimaryType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="struct_table.html">Table</a>&lt; scope, code, table, Record, PrimaryType, void &gt;::PrimaryIndex::previous </td>
          <td>(</td>
          <td class="paramtype">Record &amp;&#160;</td>
          <td class="paramname"><em>r</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">r</td><td>- reference to store previous record. Must be initialized with a key.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successfully retrieved the previous record. </dd></dl>

</div>
</div>
<a class="anchor" id="a88d1097b8bcd991a7bd8a0519719ea5c"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;uint64_t scope, uint64_t code, uint64_t table, typename Record , typename PrimaryType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="struct_table.html">Table</a>&lt; scope, code, table, Record, PrimaryType, void &gt;::PrimaryIndex::remove </td>
          <td>(</td>
          <td class="paramtype">const Record &amp;&#160;</td>
          <td class="paramname"><em>r</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">r</td><td>- reference to record to be removed. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successfully removed. </dd></dl>

</div>
</div>
<a class="anchor" id="a6b86d0c5f0a735e6f962984c00925372"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;uint64_t scope, uint64_t code, uint64_t table, typename Record , typename PrimaryType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="struct_table.html">Table</a>&lt; scope, code, table, Record, PrimaryType, void &gt;::PrimaryIndex::upper_bound </td>
          <td>(</td>
          <td class="paramtype">const PrimaryType &amp;&#160;</td>
          <td class="paramname"><em>p</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Record &amp;&#160;</td>
          <td class="paramname"><em>r</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">p</td><td>- reference to the primary key to retrieve the upper bound. </td></tr>
    <tr><td class="paramname">r</td><td>- reference to hold the result of the query. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successfully retrieved the record. </dd></dl>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>contracts/eoslib/<a class="el" href="db_8hpp_source.html">db.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
